/*
 * This file is part of Applied Energistics 2.
 * Copyright (c) 2013 - 2014, AlgorithmX2, All rights reserved.
 *
 * Applied Energistics 2 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Applied Energistics 2 is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Applied Energistics 2.  If not, see <http://www.gnu.org/licenses/lgpl>.
 */

package appeng.client.gui.widgets;

import javax.annotation.Nonnull;

import net.minecraft.util.text.ITextComponent;
import net.minecraft.util.text.StringTextComponent;

/**
 * AEBaseGui controlled Tooltip Interface.
 */
public interface ITooltip {

    /**
     * Returns the tooltip message.
     * 
     * Should use {@link StringTextComponent#EMPTY} for no tooltip
     *
     * @return tooltip message
     */
    @Nonnull
    ITextComponent getTooltipMessage();

    /**
     * x Location for the object that triggers the tooltip.
     *
     * @return xPosition
     */
    int getTooltipAreaX();

    /**
     * y Location for the object that triggers the tooltip.
     *
     * @return yPosition
     */
    int getTooltipAreaY();

    /**
     * Width of the object that triggers the tooltip.
     *
     * @return width
     */
    int getTooltipAreaWidth();

    /**
     * Height for the object that triggers the tooltip.
     *
     * @return height
     */
    int getTooltipAreaHeight();

    /**
     * @return true if button being drawn
     */
    boolean isTooltipAreaVisible();
}
